Skip to main content

Samsung Bixby Outputs

Run in Postman

Output message with userId

The output message type represents a message sent by the virtual agent in a text format. It can contain plain text or various formatting options.

Please refer to output objects in Samsung Bixby's documentation.

curl --include \
--request POST \
--header "Authorization: Token BOTANALYTICS_CHANNEL_TOKEN" \
--header "Content-Type: application/json"
--data "{
   'messages': [
      {
         'message': {
           
         }
      }
   ]
}" \
https://api.beta.botanalytics.co/v2/messages

Field Descriptions

  • messages (array): An array containing messages.
    • message (object): Represents an individual message.
      • timestamp (number): The timestamp (in milliseconds) of the output.

Please note that the message object within messages array above has the Bixby's native output format plus timestamp field which is required for each message object.

Example of single message payload in JSON format

{
  "messages": [
    {
      "message": {
        "timestamp": 1458692752478,
        "output": "Output",
        "action": "mail-action",
        "$vivContext": {
            "canTypeId": "bixby-mobile-en-US",
            "device": "bixby-mobile",
            "userId": "u1",
            "locale": "en-US",
            "timezone": "America/Los_Angeles",
            "testToday": null,
            "accessToken": null,
            "svcId": null,
            "rampcode": null,
            "conversationId": null,
            "requestId": null,
            "sessionId": "0a8ff565bfbace92f7739f521824d15816f056588af43205415984598d0aebfd",
            "handsFree": false,
            "storeCountry": "",
            "deviceModel": "",
            "productCode": null,
            "screenLocked": false,
            "utterance": null,
            "clientAppId": null,
            "clientAppVersion": null,
            "drivingMode": false,
            "grantedPermissions": {},
            "is24HourFormat": false,
            "bixbyUserId": null,
            "allowLockScreenExecution": false
        }
      }
    }
  ]
}

Example of multiple messages payload in JSON format

{
  "messages": [
    {
      "message": {
        "timestamp": 1458692752478,
        "output": "Output",
        "action": "mail-action",
        "$vivContext": {
            "canTypeId": "bixby-mobile-en-US",
            "device": "bixby-mobile",
            "userId": "u1",
            "locale": "en-US",
            "timezone": "America/Los_Angeles",
            "testToday": null,
            "accessToken": null,
            "svcId": null,
            "rampcode": null,
            "conversationId": null,
            "requestId": null,
            "sessionId": "0a8ff565bfbace92f7739f521824d15816f056588af43205415984598d0aebfd",
            "handsFree": false,
            "storeCountry": "",
            "deviceModel": "",
            "productCode": null,
            "screenLocked": false,
            "utterance": null,
            "clientAppId": null,
            "clientAppVersion": null,
            "drivingMode": false,
            "grantedPermissions": {},
            "is24HourFormat": false,
            "bixbyUserId": null,
            "allowLockScreenExecution": false
        }
      }
    },
    {
      "message": {
        "timestamp": 1458692752600,
        "output": "Output",
        "action": "message-action",
        "$vivContext": {
            "canTypeId": "bixby-mobile-en-US",
            "device": "bixby-mobile",
            "userId": "u1",
            "locale": "en-US",
            "timezone": "America/Los_Angeles",
            "testToday": null,
            "accessToken": null,
            "svcId": null,
            "rampcode": null,
            "conversationId": null,
            "requestId": null,
            "sessionId": "0a8ff565bfbace92f7739f521824d15816f056588af43205415984598d0aebfd",
            "handsFree": false,
            "storeCountry": "",
            "deviceModel": "",
            "productCode": null,
            "screenLocked": false,
            "utterance": null,
            "clientAppId": null,
            "clientAppVersion": null,
            "drivingMode": false,
            "grantedPermissions": {},
            "is24HourFormat": false,
            "bixbyUserId": null,
            "allowLockScreenExecution": false
        }
      }
    }
  ]
}

Output message with bixbyUserId

The output message type represents a message sent by the virtual agent in a text format. It can contain plain text or various formatting options.

Example of single message payload in JSON format

{
  "messages": [
    {
      "message": {
        "timestamp": 1458692752478,
        "output": "Output",
        "action": "mail-action",
        "$vivContext": {
            "canTypeId": "bixby-mobile-en-US",
            "device": "bixby-mobile",
            "bixbyUserId": "u1",
            "locale": "en-US",
            "timezone": "America/Los_Angeles",
            "testToday": null,
            "accessToken": null,
            "svcId": null,
            "rampcode": null,
            "conversationId": null,
            "requestId": null,
            "sessionId": "0a8ff565bfbace92f7739f521824d15816f056588af43205415984598d0aebfd",
            "handsFree": false,
            "storeCountry": "",
            "deviceModel": "",
            "productCode": null,
            "screenLocked": false,
            "utterance": null,
            "clientAppId": null,
            "clientAppVersion": null,
            "drivingMode": false,
            "grantedPermissions": {},
            "is24HourFormat": false,
            "bixbyUserId": null,
            "allowLockScreenExecution": false
        }
      }
    }
  ]
}

Example of multiple messages payload in JSON format

{
  "messages": [
    {
      "message": {
        "timestamp": 1458692752478,
        "output": "Output",
        "action": "mail-action",
        "$vivContext": {
            "canTypeId": "bixby-mobile-en-US",
            "device": "bixby-mobile",
            "bixbyUserId": "u1",
            "locale": "en-US",
            "timezone": "America/Los_Angeles",
            "testToday": null,
            "accessToken": null,
            "svcId": null,
            "rampcode": null,
            "conversationId": null,
            "requestId": null,
            "sessionId": "0a8ff565bfbace92f7739f521824d15816f056588af43205415984598d0aebfd",
            "handsFree": false,
            "storeCountry": "",
            "deviceModel": "",
            "productCode": null,
            "screenLocked": false,
            "utterance": null,
            "clientAppId": null,
            "clientAppVersion": null,
            "drivingMode": false,
            "grantedPermissions": {},
            "is24HourFormat": false,
            "bixbyUserId": null,
            "allowLockScreenExecution": false
        }
      }
    },
    {
      "message": {
        "timestamp": 1458692752600,
        "output": "Output",
        "action": "message-action",
        "$vivContext": {
            "canTypeId": "bixby-mobile-en-US",
            "device": "bixby-mobile",
            "bixbyUserId": "u1",
            "locale": "en-US",
            "timezone": "America/Los_Angeles",
            "testToday": null,
            "accessToken": null,
            "svcId": null,
            "rampcode": null,
            "conversationId": null,
            "requestId": null,
            "sessionId": "0a8ff565bfbace92f7739f521824d15816f056588af43205415984598d0aebfd",
            "handsFree": false,
            "storeCountry": "",
            "deviceModel": "",
            "productCode": null,
            "screenLocked": false,
            "utterance": null,
            "clientAppId": null,
            "clientAppVersion": null,
            "drivingMode": false,
            "grantedPermissions": {},
            "is24HourFormat": false,
            "bixbyUserId": null,
            "allowLockScreenExecution": false
        }
      }
    }
  ]
}